Skip to main content

RegistryContract

Contracts • API

Holograph SDK Reference / Contracts / RegistryContract

Class: RegistryContract

Remarks​

Registry is a central on-chain location where all Holograph data is stored. Registry keeps a record of all currently supported standards. New standards can be introduced and enabled as well. Any properly deployed Holographed contracts are also stored as reference. This allows for a definitive way to identify whether a smart contract is secure and properly Holographed. Verifying entities will be able to identify a Holographed contract to ensure the highest level of security and standards.

Extends​

Constructors​

new RegistryContract(parentLogger)​

new RegistryContract(parentLogger?): RegistryContract

Parameters​

• parentLogger?: HolographLogger

Returns​

RegistryContract

Overrides​

HolographBaseContract.constructor

Source​

packages/sdk/src/contracts/registry.contract.ts:21

Properties​

_abi​

protected readonly _abi: Abi

Inherited from​

HolographBaseContract._abi

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:43

_addresses​

protected readonly _addresses: Record<number, 0x${string}> = {}

The record of addresses per chainId.

Inherited from​

HolographBaseContract._addresses

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:36

_config​

protected readonly _config: Config

Inherited from​

HolographBaseContract._config

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:41

_logger​

protected _logger: HolographLogger

Inherited from​

HolographBaseContract._logger

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:42

_providers​

protected readonly _providers: Providers

Inherited from​

HolographBaseContract._providers

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:37

_walletManager?​

protected optional _walletManager: HolographWalletManager

Inherited from​

HolographBaseContract._walletManager

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:38

networks​

readonly networks: Network[]

The list of networks in which the contract was instantiated.

Inherited from​

HolographBaseContract.networks

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:34

Methods​

_callContractFunction()​

protected _callContractFunction<TAbi>(__namedParameters): Promise<string | string[]>

Type parameters​

• TAbi extends Abi

Parameters​

• __namedParameters: CallContractFunctionArgs<TAbi>

Returns​

Promise<string | string[]>

Inherited from​

HolographBaseContract._callContractFunction

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:147

_estimateContractGas()​

protected _estimateContractGas<TAbi>(__namedParameters): Promise<bigint>

Type parameters​

• TAbi extends Abi

Parameters​

• __namedParameters: EstimateContractGasArgs<TAbi>

Returns​

Promise<bigint>

Inherited from​

HolographBaseContract._estimateContractGas

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:106

_getContractFunction()​

private _getContractFunction(__namedParameters): Promise<string | string[]>

Parameters​

• __namedParameters: GetContractFunctionArgs<[object, object, object, object, object]>

Returns​

Promise<string | string[]>

Source​

packages/sdk/src/contracts/registry.contract.ts:49

_readContract()​

protected _readContract<TAbi>(__namedParameters): Promise<unknown>

Type parameters​

• TAbi extends Abi

Parameters​

• __namedParameters: ReadContractArgs<TAbi>

Returns​

Promise<unknown>

Inherited from​

HolographBaseContract._readContract

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:138

_simulateContract()​

protected _simulateContract<TAbi>(__namedParameters): Promise<any>

Type parameters​

• TAbi extends Abi

Parameters​

• __namedParameters: SimulateContractArgs<TAbi>

Returns​

Promise<any>

Inherited from​

HolographBaseContract._simulateContract

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:72

_writeContract()​

protected _writeContract<TAbi>(__namedParameters): Promise<0x${string}>

Type parameters​

• TAbi extends Abi

Parameters​

• __namedParameters: WriteContractArgs<TAbi>

Returns​

Promise<0x${string}>

Inherited from​

HolographBaseContract._writeContract

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:122

getAddress()​

readonly getAddress(chainId): Promise<0x${string}>

Get the HolographRegistry contract address according to environment and chainId module.

Parameters​

• chainId: number

The chain id of the network to get the result from.

Returns​

Promise<0x${string}>

The HolographRegistry contract address in the provided network.

Source​

packages/sdk/src/contracts/registry.contract.ts:39

getClientByChainId()​

readonly getClientByChainId(chainId): Promise<object>

Get the Viem client for a certain network.

Parameters​

• chainId: number

The chain id of the network to get the result from.

Returns​

Promise<object>

The Viem client object.

account​

account: undefined

The Account of the Client.

batch?​

optional batch: object

Flags for batch settings.

batch.multicall?​

optional multicall: boolean | { batchSize?: number | undefined; wait?: number | undefined; }

Toggle to enable eth_call multicall aggregation.

cacheTime​

cacheTime: number

Time (in ms) that cached data will remain in memory.

call()​

call: (parameters) => Promise<CallReturnType>

Executes a new message call immediately without submitting a transaction to the network.

Parameters​

• parameters: CallParameters<undefined | Chain>

Returns​

Promise<CallReturnType>

The call data. CallReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const data = await client.call({
account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
})
chain​

chain: undefined | Chain

Chain for the client.

createBlockFilter()​

createBlockFilter: () => Promise<object>

Creates a Filter to listen for new block hashes that can be used with getFilterChanges.

Returns​

Promise<object>

Filter. CreateBlockFilterReturnType

id​

id: 0x${string}

request​

request: EIP1193RequestFn<readonly [object, object, object]>

type​

type: "block"

Example​
import { createPublicClient, createBlockFilter, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await createBlockFilter(client)
// { id: "0x345a6572337856574a76364e457a4366", type: 'block' }
createContractEventFilter()​

createContractEventFilter: <TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>(args) => Promise<CreateContractEventFilterReturnType<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>>

Creates a Filter to retrieve event logs that can be used with getFilterChanges or getFilterLogs.

Type parameters​

• TAbi extends readonly unknown[] | Abi

• TEventName extends undefined | string

• TArgs extends undefined | readonly unknown[] | Record<string, unknown>

• TStrict extends undefined | boolean = undefined

• TFromBlock extends undefined | bigint | BlockTag = undefined

• TToBlock extends undefined | bigint | BlockTag = undefined

Parameters​

• args: CreateContractEventFilterParameters<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>

CreateContractEventFilterParameters

Returns​

Promise<CreateContractEventFilterReturnType<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>>

Filter. CreateContractEventFilterReturnType

Example​
import { createPublicClient, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createContractEventFilter({
abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']),
})
createEventFilter()​

createEventFilter: <TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>(args?) => Promise<{ [K in keyof Filter<"event", TAbiEvents, _EventName, _Args, TStrict, TFromBlock, TToBlock>]: Filter<"event", TAbiEvents, ... 4 more ..., TToBlock>[K]; }>

Creates a Filter to listen for new events that can be used with getFilterChanges.

Type parameters​

• TAbiEvent extends undefined | AbiEvent = undefined

• TAbiEvents extends undefined | readonly unknown[] | readonly AbiEvent[] = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined

• TStrict extends undefined | boolean = undefined

• TFromBlock extends undefined | bigint | BlockTag = undefined

• TToBlock extends undefined | bigint | BlockTag = undefined

• _EventName extends undefined | string = MaybeAbiEventName<TAbiEvent>

• _Args extends undefined | readonly unknown[] | Record<string, unknown> = undefined

Parameters​

• args?: CreateEventFilterParameters<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>

CreateEventFilterParameters

Returns​

Promise<{ [K in keyof Filter<"event", TAbiEvents, _EventName, _Args, TStrict, TFromBlock, TToBlock>]: Filter<"event", TAbiEvents, ... 4 more ..., TToBlock>[K]; }>

Filter. CreateEventFilterReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createEventFilter({
address: '0xfba3912ca04dd458c843e2ee08967fc04f3579c2',
})
createPendingTransactionFilter()​

createPendingTransactionFilter: () => Promise<object>

Creates a Filter to listen for new pending transaction hashes that can be used with getFilterChanges.

Returns​

Promise<object>

Filter. CreateBlockFilterReturnType

id​

id: 0x${string}

request​

request: EIP1193RequestFn<readonly [object, object, object]>

type​

type: "transaction"

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createPendingTransactionFilter()
// { id: "0x345a6572337856574a76364e457a4366", type: 'transaction' }
estimateContractGas()​

estimateContractGas: <TChain, abi, functionName, args>(args) => Promise<bigint>

Estimates the gas required to successfully execute a contract write function call.

Type parameters​

• TChain extends undefined | Chain

• abi extends readonly unknown[] | Abi

• functionName extends string

• args extends unknown

Parameters​

• args: EstimateContractGasParameters<abi, functionName, args, TChain>

EstimateContractGasParameters

Returns​

Promise<bigint>

The gas estimate (in wei). EstimateContractGasReturnType

Remarks​

Internally, uses a Public Client to call the estimateGas action with ABI-encoded data.

Example​
import { createPublicClient, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const gas = await client.estimateContractGas({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['function mint() public']),
functionName: 'mint',
account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
})
estimateFeesPerGas()​

estimateFeesPerGas: <TChainOverride, TType>(args?) => Promise<EstimateFeesPerGasReturnType>

Returns an estimate for the fees per gas for a transaction to be included in the next block.

Type parameters​

• TChainOverride extends undefined | Chain = undefined

• TType extends FeeValuesType = "eip1559"

Parameters​

• args?: EstimateFeesPerGasParameters<undefined | Chain, TChainOverride, TType>

Returns​

Promise<EstimateFeesPerGasReturnType>

An estimate (in wei) for the fees per gas. EstimateFeesPerGasReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const maxPriorityFeePerGas = await client.estimateFeesPerGas()
// { maxFeePerGas: ..., maxPriorityFeePerGas: ... }
estimateGas()​

estimateGas: (args) => Promise<bigint>

Estimates the gas necessary to complete a transaction without submitting it to the network.

Parameters​

• args: EstimateGasParameters<undefined | Chain>

EstimateGasParameters

Returns​

Promise<bigint>

The gas estimate (in wei). EstimateGasReturnType

Example​
import { createPublicClient, http, parseEther } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const gasEstimate = await client.estimateGas({
account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: parseEther('1'),
})
estimateMaxPriorityFeePerGas()​

estimateMaxPriorityFeePerGas: <TChainOverride>(args?) => Promise<bigint>

Returns an estimate for the max priority fee per gas (in wei) for a transaction to be included in the next block.

Type parameters​

• TChainOverride extends undefined | Chain = undefined

Parameters​

• args?

• args.chain?: null | TChainOverride

Returns​

Promise<bigint>

An estimate (in wei) for the max priority fee per gas. EstimateMaxPriorityFeePerGasReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const maxPriorityFeePerGas = await client.estimateMaxPriorityFeePerGas()
// 10000000n
extend()​

extend: <client>(fn) => Client<Transport, undefined | Chain, undefined, PublicRpcSchema, { [K in keyof client]: client[K]; } & PublicActions<Transport, undefined | Chain>>

Type parameters​

• client extends { [x: string]: unknown; account?: undefined; batch?: undefined; cacheTime?: undefined; chain?: undefined; key?: undefined; name?: undefined; pollingInterval?: undefined; request?: undefined; transport?: undefined; type?: undefined; uid?: undefined; } & Partial<ExtendableProtectedActions<Transport, undefined | Chain, undefined>>

Parameters​

• fn

Returns​

Client<Transport, undefined | Chain, undefined, PublicRpcSchema, { [K in keyof client]: client[K]; } & PublicActions<Transport, undefined | Chain>>

getBalance()​

getBalance: (args) => Promise<bigint>

Returns the balance of an address in wei.

Parameters​

• args: GetBalanceParameters

GetBalanceParameters

Returns​

Promise<bigint>

The balance of the address in wei. GetBalanceReturnType

Remarks​

You can convert the balance to ether units with formatEther.

const balance = await getBalance(client, {
address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
blockTag: 'safe'
})
const balanceAsEther = formatEther(balance)
// "6.942"
Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const balance = await client.getBalance({
address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
})
// 10000000000000000000000n (wei)
getBlock()​

getBlock: <TIncludeTransactions, TBlockTag>(args?) => Promise<{ number: TBlockTag extends "pending" ? null : bigint; gasLimit: bigint; hash: TBlockTag extends "pending" ? null : `0x${string}`; nonce: TBlockTag extends "pending" ? null : `0x${string}`; ... 21 more ...; transactions: TIncludeTransactions extends true ? ({ ...; } | ... 2 more ... | { ...; })[] : `0x${string}`[]; }>

Returns information about a block at a block number, hash, or tag.

Type parameters​

• TIncludeTransactions extends boolean = false

• TBlockTag extends BlockTag = "latest"

Parameters​

• args?: GetBlockParameters<TIncludeTransactions, TBlockTag>

GetBlockParameters

Returns​

Promise<{ number: TBlockTag extends "pending" ? null : bigint; gasLimit: bigint; hash: TBlockTag extends "pending" ? null : `0x${string}`; nonce: TBlockTag extends "pending" ? null : `0x${string}`; ... 21 more ...; transactions: TIncludeTransactions extends true ? ({ ...; } | ... 2 more ... | { ...; })[] : `0x${string}`[]; }>

Information about the block. GetBlockReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const block = await client.getBlock()
getBlockNumber()​

getBlockNumber: (args?) => Promise<bigint>

Returns the number of the most recent block seen.

Parameters​

• args?: GetBlockNumberParameters

GetBlockNumberParameters

Returns​

Promise<bigint>

The number of the block. GetBlockNumberReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const blockNumber = await client.getBlockNumber()
// 69420n
getBlockTransactionCount()​

getBlockTransactionCount: (args?) => Promise<number>

Returns the number of Transactions at a block number, hash, or tag.

Parameters​

• args?: GetBlockTransactionCountParameters

GetBlockTransactionCountParameters

Returns​

Promise<number>

The block transaction count. GetBlockTransactionCountReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const count = await client.getBlockTransactionCount()
getBytecode()​

getBytecode: (args) => Promise<GetBytecodeReturnType>

Retrieves the bytecode at an address.

Parameters​

• args: GetBytecodeParameters

GetBytecodeParameters

Returns​

Promise<GetBytecodeReturnType>

The contract's bytecode. GetBytecodeReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const code = await client.getBytecode({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
})
getChainId()​

getChainId: () => Promise<number>

Returns the chain ID associated with the current network.

Returns​

Promise<number>

The current chain ID. GetChainIdReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const chainId = await client.getChainId()
// 1
getContractEvents()​

getContractEvents: <abi, eventName, strict, fromBlock, toBlock>(args) => Promise<GetContractEventsReturnType<abi, eventName, strict, fromBlock, toBlock>>

Returns a list of event logs emitted by a contract.

Type parameters​

• abi extends readonly unknown[] | Abi

• eventName extends undefined | string = undefined

• strict extends undefined | boolean = undefined

• fromBlock extends undefined | bigint | BlockTag = undefined

• toBlock extends undefined | bigint | BlockTag = undefined

Parameters​

• args: GetContractEventsParameters<abi, eventName, strict, fromBlock, toBlock>

Returns​

Promise<GetContractEventsReturnType<abi, eventName, strict, fromBlock, toBlock>>

A list of event logs. GetContractEventsReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { wagmiAbi } from './abi'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const logs = await client.getContractEvents(client, {
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: wagmiAbi,
eventName: 'Transfer'
})
getEnsAddress()​

getEnsAddress: (args) => Promise<GetEnsAddressReturnType>

Gets address for ENS name.

Parameters​

• args: { blockNumber?: bigint | undefined; blockTag?: BlockTag | undefined; coinType?: number | undefined; gatewayUrls?: string[] | undefined; name: string; strict?: boolean | undefined; universalResolverAddress?: `0x${string}` | undefined; }

GetEnsAddressParameters

Returns​

Promise<GetEnsAddressReturnType>

Address for ENS name or null if not found. GetEnsAddressReturnType

Remarks​

Calls resolve(bytes, bytes) on ENS Universal Resolver Contract.

Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to normalize ENS names with UTS-46 normalization before passing them to getEnsAddress. You can use the built-in normalize function for this.

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { normalize } from 'viem/ens'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const ensAddress = await client.getEnsAddress({
name: normalize('wevm.eth'),
})
// '0xd2135CfB216b74109775236E36d4b433F1DF507B'
getEnsAvatar()​

getEnsAvatar: (args) => Promise<GetEnsAvatarReturnType>

Gets the avatar of an ENS name.

Parameters​

• args: { name: string; blockNumber?: bigint | undefined; blockTag?: BlockTag | undefined; gatewayUrls?: string[] | undefined; strict?: boolean | undefined; universalResolverAddress?: `0x${string}` | undefined; assetGatewayUrls?: AssetGatewayUrls | undefined; }

GetEnsAvatarParameters

Returns​

Promise<GetEnsAvatarReturnType>

Avatar URI or null if not found. GetEnsAvatarReturnType

Remarks​

Calls getEnsText with key set to 'avatar'.

Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to normalize ENS names with UTS-46 normalization before passing them to getEnsAddress. You can use the built-in normalize function for this.

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { normalize } from 'viem/ens'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const ensAvatar = await client.getEnsAvatar({
name: normalize('wevm.eth'),
})
// 'https://ipfs.io/ipfs/Qma8mnp6xV3J2cRNf3mTth5C8nV11CAnceVinc3y8jSbio'
getEnsName()​

getEnsName: (args) => Promise<GetEnsNameReturnType>

Gets primary name for specified address.

Parameters​

• args: { blockNumber?: bigint | undefined; blockTag?: BlockTag | undefined; address: `0x${string}`; gatewayUrls?: string[] | undefined; strict?: boolean | undefined; universalResolverAddress?: `0x${string}` | undefined; }

GetEnsNameParameters

Returns​

Promise<GetEnsNameReturnType>

Name or null if not found. GetEnsNameReturnType

Remarks​

Calls reverse(bytes) on ENS Universal Resolver Contract to "reverse resolve" the address to the primary ENS name.

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const ensName = await client.getEnsName({
address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
})
// 'wevm.eth'
getEnsResolver()​

getEnsResolver: (args) => Promise<0x${string}>

Gets resolver for ENS name.

Parameters​

• args: { blockNumber?: bigint | undefined; blockTag?: BlockTag | undefined; name: string; universalResolverAddress?: `0x${string}` | undefined; }

GetEnsResolverParameters

Returns​

Promise<0x${string}>

Address for ENS resolver. GetEnsResolverReturnType

Remarks​

Calls findResolver(bytes) on ENS Universal Resolver Contract to retrieve the resolver of an ENS name.

Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to normalize ENS names with UTS-46 normalization before passing them to getEnsAddress. You can use the built-in normalize function for this.

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { normalize } from 'viem/ens'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const resolverAddress = await client.getEnsResolver({
name: normalize('wevm.eth'),
})
// '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41'
getEnsText()​

getEnsText: (args) => Promise<GetEnsTextReturnType>

Gets a text record for specified ENS name.

Parameters​

• args: { blockNumber?: bigint | undefined; blockTag?: BlockTag | undefined; name: string; gatewayUrls?: string[] | undefined; key: string; strict?: boolean | undefined; universalResolverAddress?: `0x${string}` | undefined; }

GetEnsTextParameters

Returns​

Promise<GetEnsTextReturnType>

Address for ENS resolver. GetEnsTextReturnType

Remarks​

Calls resolve(bytes, bytes) on ENS Universal Resolver Contract.

Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to normalize ENS names with UTS-46 normalization before passing them to getEnsAddress. You can use the built-in normalize function for this.

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { normalize } from 'viem/ens'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const twitterRecord = await client.getEnsText({
name: normalize('wevm.eth'),
key: 'com.twitter',
})
// 'wagmi_sh'
getFeeHistory()​

getFeeHistory: (args) => Promise<GetFeeHistoryReturnType>

Returns a collection of historical gas information.

Parameters​

• args: GetFeeHistoryParameters

GetFeeHistoryParameters

Returns​

Promise<GetFeeHistoryReturnType>

The gas estimate (in wei). GetFeeHistoryReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const feeHistory = await client.getFeeHistory({
blockCount: 4,
rewardPercentiles: [25, 75],
})
getFilterChanges()​

getFilterChanges: <TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args) => Promise<GetFilterChangesReturnType<TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>>

Returns a list of logs or hashes based on a Filter since the last time it was called.

Type parameters​

• TFilterType extends FilterType

• TAbi extends undefined | readonly unknown[] | Abi

• TEventName extends undefined | string

• TStrict extends undefined | boolean = undefined

• TFromBlock extends undefined | bigint | BlockTag = undefined

• TToBlock extends undefined | bigint | BlockTag = undefined

Parameters​

• args: GetFilterChangesParameters<TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>

GetFilterChangesParameters

Returns​

Promise<GetFilterChangesReturnType<TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>>

Logs or hashes. GetFilterChangesReturnType

Remarks​

A Filter can be created from the following actions:

Depending on the type of filter, the return value will be different:

  • If the filter was created with createContractEventFilter or createEventFilter, it returns a list of logs.
  • If the filter was created with createPendingTransactionFilter, it returns a list of transaction hashes.
  • If the filter was created with createBlockFilter, it returns a list of block hashes.
Example​
// Blocks
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createBlockFilter()
const hashes = await client.getFilterChanges({ filter })
Example​
// Contract Events
import { createPublicClient, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createContractEventFilter({
address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']),
eventName: 'Transfer',
})
const logs = await client.getFilterChanges({ filter })
Example​
// Raw Events
import { createPublicClient, http, parseAbiItem } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createEventFilter({
address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
event: parseAbiItem('event Transfer(address indexed, address indexed, uint256)'),
})
const logs = await client.getFilterChanges({ filter })
Example​
// Transactions
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createPendingTransactionFilter()
const hashes = await client.getFilterChanges({ filter })
getFilterLogs()​

getFilterLogs: <TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args) => Promise<GetFilterLogsReturnType<TAbi, TEventName, TStrict, TFromBlock, TToBlock>>

Returns a list of event logs since the filter was created.

Type parameters​

• TAbi extends undefined | readonly unknown[] | Abi

• TEventName extends undefined | string

• TStrict extends undefined | boolean = undefined

• TFromBlock extends undefined | bigint | BlockTag = undefined

• TToBlock extends undefined | bigint | BlockTag = undefined

Parameters​

• args: GetFilterLogsParameters<TAbi, TEventName, TStrict, TFromBlock, TToBlock>

GetFilterLogsParameters

Returns​

Promise<GetFilterLogsReturnType<TAbi, TEventName, TStrict, TFromBlock, TToBlock>>

A list of event logs. GetFilterLogsReturnType

Remarks​

getFilterLogs is only compatible with event filters.

Example​
import { createPublicClient, http, parseAbiItem } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createEventFilter({
address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
event: parseAbiItem('event Transfer(address indexed, address indexed, uint256)'),
})
const logs = await client.getFilterLogs({ filter })
getGasPrice()​

getGasPrice: () => Promise<bigint>

Returns the current price of gas (in wei).

Returns​

Promise<bigint>

The gas price (in wei). GetGasPriceReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const gasPrice = await client.getGasPrice()
getLogs()​

getLogs: <TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>(args?) => Promise<GetLogsReturnType<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>>

Returns a list of event logs matching the provided parameters.

Type parameters​

• TAbiEvent extends undefined | AbiEvent = undefined

• TAbiEvents extends undefined | readonly unknown[] | readonly AbiEvent[] = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined

• TStrict extends undefined | boolean = undefined

• TFromBlock extends undefined | bigint | BlockTag = undefined

• TToBlock extends undefined | bigint | BlockTag = undefined

Parameters​

• args?: GetLogsParameters<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>

GetLogsParameters

Returns​

Promise<GetLogsReturnType<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>>

A list of event logs. GetLogsReturnType

Example​
import { createPublicClient, http, parseAbiItem } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const logs = await client.getLogs()
getProof()​

getProof: (args) => Promise<GetProofReturnType>

Returns the account and storage values of the specified account including the Merkle-proof.

Parameters​

• args: GetProofParameters

Returns​

Promise<GetProofReturnType>

Proof data. GetProofReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const block = await client.getProof({
address: '0x...',
storageKeys: ['0x...'],
})
getStorageAt()​

getStorageAt: (args) => Promise<GetStorageAtReturnType>

Returns the value from a storage slot at a given address.

Parameters​

• args: GetStorageAtParameters

GetStorageAtParameters

Returns​

Promise<GetStorageAtReturnType>

The value of the storage slot. GetStorageAtReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { getStorageAt } from 'viem/contract'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const code = await client.getStorageAt({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
slot: toHex(0),
})
getTransaction()​

getTransaction: <TBlockTag>(args) => Promise<{ type: "legacy"; gasPrice: bigint; hash: `0x${string}`; v: bigint; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; value: bigint; chainId?: number | undefined; nonce: number; from: `0x${string}`; gas: bigint; ... 10 more ...; transactionIndex: (TBlockTag extends "pending" ? true : false) extends true ... | { type: "eip2930"; gasPrice: bigint; hash: `0x${string}`; v: bigint; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; value: bigint; chainId: number; nonce: number; from: `0x${string}`; gas: bigint; maxFeePerBlobGas?: undefined; ... 9 more ...; transactionIndex: (TBlockTag extends "pending" ? true : fal... | { type: "eip1559"; gasPrice?: undefined; hash: `0x${string}`; v: bigint; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; value: bigint; chainId: number; nonce: number; from: `0x${string}`; gas: bigint; maxFeePerBlobGas?: undefined; ... 9 more ...; transactionIndex: (TBlockTag extends "pending" ? true :... | { type: "eip4844"; gasPrice?: undefined; hash: `0x${string}`; v: bigint; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; value: bigint; chainId: number; nonce: number; from: `0x${string}`; gas: bigint; maxFeePerBlobGas: bigint; ... 9 more ...; transactionIndex: (TBlockTag extends "pending" ? true : fal...>

Returns information about a Transaction given a hash or block identifier.

Type parameters​

• TBlockTag extends BlockTag = "latest"

Parameters​

• args: GetTransactionParameters<TBlockTag>

GetTransactionParameters

Returns​

Promise<{ type: "legacy"; gasPrice: bigint; hash: `0x${string}`; v: bigint; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; value: bigint; chainId?: number | undefined; nonce: number; from: `0x${string}`; gas: bigint; ... 10 more ...; transactionIndex: (TBlockTag extends "pending" ? true : false) extends true ... | { type: "eip2930"; gasPrice: bigint; hash: `0x${string}`; v: bigint; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; value: bigint; chainId: number; nonce: number; from: `0x${string}`; gas: bigint; maxFeePerBlobGas?: undefined; ... 9 more ...; transactionIndex: (TBlockTag extends "pending" ? true : fal... | { type: "eip1559"; gasPrice?: undefined; hash: `0x${string}`; v: bigint; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; value: bigint; chainId: number; nonce: number; from: `0x${string}`; gas: bigint; maxFeePerBlobGas?: undefined; ... 9 more ...; transactionIndex: (TBlockTag extends "pending" ? true :... | { type: "eip4844"; gasPrice?: undefined; hash: `0x${string}`; v: bigint; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; value: bigint; chainId: number; nonce: number; from: `0x${string}`; gas: bigint; maxFeePerBlobGas: bigint; ... 9 more ...; transactionIndex: (TBlockTag extends "pending" ? true : fal...>

The transaction information. GetTransactionReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const transaction = await client.getTransaction({
hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
getTransactionConfirmations()​

getTransactionConfirmations: (args) => Promise<bigint>

Returns the number of blocks passed (confirmations) since the transaction was processed on a block.

Parameters​

• args: GetTransactionConfirmationsParameters<undefined | Chain>

GetTransactionConfirmationsParameters

Returns​

Promise<bigint>

The number of blocks passed since the transaction was processed. If confirmations is 0, then the Transaction has not been confirmed & processed yet. GetTransactionConfirmationsReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const confirmations = await client.getTransactionConfirmations({
hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
getTransactionCount()​

getTransactionCount: (args) => Promise<number>

Returns the number of Transactions an Account has broadcast / sent.

Parameters​

• args: GetTransactionCountParameters

GetTransactionCountParameters

Returns​

Promise<number>

The number of transactions an account has sent. GetTransactionCountReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const transactionCount = await client.getTransactionCount({
address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
})
getTransactionReceipt()​

getTransactionReceipt: (args) => Promise<TransactionReceipt>

Returns the Transaction Receipt given a Transaction hash.

Parameters​

• args: GetTransactionReceiptParameters

GetTransactionReceiptParameters

Returns​

Promise<TransactionReceipt>

The transaction receipt. GetTransactionReceiptReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const transactionReceipt = await client.getTransactionReceipt({
hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
key​

key: string

A key for the client.

multicall()​

multicall: <contracts, allowFailure>(args) => Promise<MulticallReturnType<contracts, allowFailure>>

Similar to readContract, but batches up multiple functions on a contract in a single RPC call via the multicall3 contract.

Type parameters​

• contracts extends readonly unknown[]

• allowFailure extends boolean = true

Parameters​

• args: MulticallParameters<contracts, allowFailure>

MulticallParameters

Returns​

Promise<MulticallReturnType<contracts, allowFailure>>

An array of results with accompanying status. MulticallReturnType

Example​
import { createPublicClient, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const abi = parseAbi([
'function balanceOf(address) view returns (uint256)',
'function totalSupply() view returns (uint256)',
])
const result = await client.multicall({
contracts: [
{
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi,
functionName: 'balanceOf',
args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'],
},
{
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi,
functionName: 'totalSupply',
},
],
})
// [{ result: 424122n, status: 'success' }, { result: 1000000n, status: 'success' }]
name​

name: string

A name for the client.

pollingInterval​

pollingInterval: number

Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds.

prepareTransactionRequest()​

prepareTransactionRequest: <TParameterType, TChainOverride, TAccountOverride>(args) => Promise<PrepareTransactionRequestReturnType<Chain, undefined | Account, TChainOverride, TAccountOverride, TParameterType>>

Prepares a transaction request for signing.

Type parameters​

• TParameterType extends PrepareTransactionRequestParameterType

• TChainOverride extends undefined | Chain = undefined

• TAccountOverride extends undefined | 0x${string} | Account = undefined

Parameters​

• args: PrepareTransactionRequestParameters<undefined | Chain, undefined | Account, TChainOverride, TAccountOverride, TParameterType>

PrepareTransactionRequestParameters

Returns​

Promise<PrepareTransactionRequestReturnType<Chain, undefined | Account, TChainOverride, TAccountOverride, TParameterType>>

The transaction request. PrepareTransactionRequestReturnType

Example​
import { createWalletClient, custom } from 'viem'
import { mainnet } from 'viem/chains'

const client = createWalletClient({
chain: mainnet,
transport: custom(window.ethereum),
})
const request = await client.prepareTransactionRequest({
account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
to: '0x0000000000000000000000000000000000000000',
value: 1n,
})
Example​
// Account Hoisting
import { createWalletClient, http } from 'viem'
import { privateKeyToAccount } from 'viem/accounts'
import { mainnet } from 'viem/chains'

const client = createWalletClient({
account: privateKeyToAccount('0x…'),
chain: mainnet,
transport: custom(window.ethereum),
})
const request = await client.prepareTransactionRequest({
to: '0x0000000000000000000000000000000000000000',
value: 1n,
})
readContract()​

readContract: <abi, functionName, args>(args) => Promise<ReadContractReturnType<abi, functionName, args>>

Calls a read-only function on a contract, and returns the response.

Type parameters​

• abi extends readonly unknown[] | Abi

• functionName extends string

• args extends unknown

Parameters​

• args: ReadContractParameters<abi, functionName, args>

ReadContractParameters

Returns​

Promise<ReadContractReturnType<abi, functionName, args>>

The response from the contract. Type is inferred. ReadContractReturnType

Remarks​

A "read-only" function (constant function) on a Solidity contract is denoted by a view or pure keyword. They can only read the state of the contract, and cannot make any changes to it. Since read-only methods do not change the state of the contract, they do not require any gas to be executed, and can be called by any user without the need to pay for gas.

Internally, uses a Public Client to call the call action with ABI-encoded data.

Example​
import { createPublicClient, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
import { readContract } from 'viem/contract'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const result = await client.readContract({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['function balanceOf(address) view returns (uint256)']),
functionName: 'balanceOf',
args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'],
})
// 424122n
request​

request: EIP1193RequestFn<PublicRpcSchema>

Request function wrapped with friendly error handling

sendRawTransaction()​

sendRawTransaction: (args) => Promise<0x${string}>

Sends a signed transaction to the network

Parameters​

• args: SendRawTransactionParameters

Returns​

Promise<0x${string}>

The transaction hash. SendRawTransactionReturnType

Example​
import { createWalletClient, custom } from 'viem'
import { mainnet } from 'viem/chains'
import { sendRawTransaction } from 'viem/wallet'

const client = createWalletClient({
chain: mainnet,
transport: custom(window.ethereum),
})

const hash = await client.sendRawTransaction({
serializedTransaction: '0x02f850018203118080825208808080c080a04012522854168b27e5dc3d5839bab5e6b39e1a0ffd343901ce1622e3d64b48f1a04e00902ae0502c4728cbf12156290df99c3ed7de85b1dbfe20b5c36931733a33'
})
simulateContract()​

simulateContract: <abi, functionName, args, chainOverride, accountOverride>(args) => Promise<SimulateContractReturnType<abi, functionName, args, undefined | Chain, undefined | Account, chainOverride, accountOverride>>

Simulates/validates a contract interaction. This is useful for retrieving return data and revert reasons of contract write functions.

Type parameters​

• abi extends readonly unknown[] | Abi

• functionName extends string

• args extends unknown

• chainOverride extends undefined | Chain

• accountOverride extends undefined | 0x${string} | Account = undefined

Parameters​

• args: SimulateContractParameters<abi, functionName, args, undefined | Chain, chainOverride, accountOverride>

SimulateContractParameters

Returns​

Promise<SimulateContractReturnType<abi, functionName, args, undefined | Chain, undefined | Account, chainOverride, accountOverride>>

The simulation result and write request. SimulateContractReturnType

Remarks​

This function does not require gas to execute and does not change the state of the blockchain. It is almost identical to readContract, but also supports contract write functions.

Internally, uses a Public Client to call the call action with ABI-encoded data.

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const result = await client.simulateContract({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['function mint(uint32) view returns (uint32)']),
functionName: 'mint',
args: ['69420'],
account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
})
transport​

transport: TransportConfig<string, EIP1193RequestFn> & Record<string, any>

The RPC transport

type​

type: string

The type of client.

uid​

uid: string

A unique ID for the client.

uninstallFilter()​

uninstallFilter: (args) => Promise<boolean>

Destroys a Filter that was created from one of the following Actions:

Parameters​

• args: UninstallFilterParameters

UninstallFilterParameters

Returns​

Promise<boolean>

A boolean indicating if the Filter was successfully uninstalled. UninstallFilterReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { createPendingTransactionFilter, uninstallFilter } from 'viem/public'

const filter = await client.createPendingTransactionFilter()
const uninstalled = await client.uninstallFilter({ filter })
// true
verifyMessage()​

verifyMessage: (args) => Promise<boolean>

Parameters​

• args: VerifyMessageParameters

Returns​

Promise<boolean>

verifyTypedData()​

verifyTypedData: (args) => Promise<boolean>

Parameters​

• args: VerifyTypedDataParameters

Returns​

Promise<boolean>

waitForTransactionReceipt()​

waitForTransactionReceipt: (args) => Promise<TransactionReceipt>

Waits for the Transaction to be included on a Block (one confirmation), and then returns the Transaction Receipt. If the Transaction reverts, then the action will throw an error.

Parameters​

• args: WaitForTransactionReceiptParameters<undefined | Chain>

WaitForTransactionReceiptParameters

Returns​

Promise<TransactionReceipt>

The transaction receipt. WaitForTransactionReceiptReturnType

Remarks​

The waitForTransactionReceipt action additionally supports Replacement detection (e.g. sped up Transactions).

Transactions can be replaced when a user modifies their transaction in their wallet (to speed up or cancel). Transactions are replaced when they are sent from the same nonce.

There are 3 types of Transaction Replacement reasons:

  • repriced: The gas price has been modified (e.g. different maxFeePerGas)
  • cancelled: The Transaction has been cancelled (e.g. value === 0n)
  • replaced: The Transaction has been replaced (e.g. different value or data)
Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const transactionReceipt = await client.waitForTransactionReceipt({
hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
watchBlockNumber()​

watchBlockNumber: (args) => WatchBlockNumberReturnType

Watches and returns incoming block numbers.

Parameters​

• args: WatchBlockNumberParameters

WatchBlockNumberParameters

Returns​

WatchBlockNumberReturnType

A function that can be invoked to stop watching for new block numbers. WatchBlockNumberReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const unwatch = await client.watchBlockNumber({
onBlockNumber: (blockNumber) => console.log(blockNumber),
})
watchBlocks()​

watchBlocks: <TIncludeTransactions, TBlockTag>(args) => WatchBlocksReturnType

Watches and returns information for incoming blocks.

Type parameters​

• TIncludeTransactions extends boolean = false

• TBlockTag extends BlockTag = "latest"

Parameters​

• args: WatchBlocksParameters<Transport, undefined | Chain, TIncludeTransactions, TBlockTag>

WatchBlocksParameters

Returns​

WatchBlocksReturnType

A function that can be invoked to stop watching for new block numbers. WatchBlocksReturnType

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const unwatch = await client.watchBlocks({
onBlock: (block) => console.log(block),
})
watchContractEvent()​

watchContractEvent: <TAbi, TEventName, TStrict>(args) => WatchContractEventReturnType

Watches and returns emitted contract event logs.

Type parameters​

• TAbi extends readonly unknown[] | Abi

• TEventName extends string

• TStrict extends undefined | boolean = undefined

Parameters​

• args: WatchContractEventParameters<TAbi, TEventName, TStrict, Transport>

WatchContractEventParameters

Returns​

WatchContractEventReturnType

A function that can be invoked to stop watching for new event logs. WatchContractEventReturnType

Remarks​

This Action will batch up all the event logs found within the pollingInterval, and invoke them via onLogs.

watchContractEvent will attempt to create an Event Filter and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. eth_newFilter), then watchContractEvent will fall back to using getLogs instead.

Example​
import { createPublicClient, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const unwatch = client.watchContractEvent({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['event Transfer(address indexed from, address indexed to, uint256 value)']),
eventName: 'Transfer',
args: { from: '0xc961145a54C96E3aE9bAA048c4F4D6b04C13916b' },
onLogs: (logs) => console.log(logs),
})
watchEvent()​

watchEvent: <TAbiEvent, TAbiEvents, TStrict>(args) => WatchEventReturnType

Watches and returns emitted Event Logs.

Type parameters​

• TAbiEvent extends undefined | AbiEvent = undefined

• TAbiEvents extends undefined | readonly unknown[] | readonly AbiEvent[] = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined

• TStrict extends undefined | boolean = undefined

Parameters​

• args: WatchEventParameters<TAbiEvent, TAbiEvents, TStrict, Transport>

WatchEventParameters

Returns​

WatchEventReturnType

A function that can be invoked to stop watching for new Event Logs. WatchEventReturnType

Remarks​

This Action will batch up all the Event Logs found within the pollingInterval, and invoke them via onLogs.

watchEvent will attempt to create an Event Filter and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. eth_newFilter), then watchEvent will fall back to using getLogs instead.

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const unwatch = client.watchEvent({
onLogs: (logs) => console.log(logs),
})
watchPendingTransactions()​

watchPendingTransactions: (args) => WatchPendingTransactionsReturnType

Watches and returns pending transaction hashes.

Parameters​

• args: WatchPendingTransactionsParameters<Transport>

WatchPendingTransactionsParameters

Returns​

WatchPendingTransactionsReturnType

A function that can be invoked to stop watching for new pending transaction hashes. WatchPendingTransactionsReturnType

Remarks​

This Action will batch up all the pending transactions found within the pollingInterval, and invoke them via onTransactions.

Example​
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const unwatch = await client.watchPendingTransactions({
onTransactions: (hashes) => console.log(hashes),
})

Inherited from​

HolographBaseContract.getClientByChainId

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:198

getContractTypeAddress()​

readonly getContractTypeAddress(chainId, contractType): Promise<string | string[]>

Returns the contract address for a contract type.

Parameters​

• chainId: number

The chain id of the network to get the result from.

• contractType: 0x${string}

The contract type bytes32.

Returns​

Promise<string | string[]>

the contract address for the provided contract type.

Source​

packages/sdk/src/contracts/registry.contract.ts:138

getContractTypeAddressByNetworks()​

readonly getContractTypeAddressByNetworks(contractType, chainIds?): Promise<HolographByNetworksResponse>

Returns the contract address for a contract type per network.

Parameters​

• contractType: 0x${string}

The contract type bytes32.

• chainIds?: number[]

The list of network chainIds to get the results from, if nothing is provided the default are the networks defined in the config.

Returns​

Promise<HolographByNetworksResponse>

the contract address for the provided contract type per network.

Source​

packages/sdk/src/contracts/registry.contract.ts:149

getGasPrice()​

getGasPrice(chainId): Promise<bigint>

Get the current gas price for a certain network.

Parameters​

• chainId: number

The chain id of the network to get the result from.

Returns​

Promise<bigint>

The gas price in wei.

Inherited from​

HolographBaseContract.getGasPrice

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:208

getHToken()​

readonly getHToken(chainId): Promise<string | string[]>

Returns the hToken address for a given chain id.

Parameters​

• chainId: number

The chain id of the network to get the result from.

Returns​

Promise<string | string[]>

the hToken contract address.

Source​

packages/sdk/src/contracts/registry.contract.ts:232

getHTokenByNetworks()​

readonly getHTokenByNetworks(chainIds?): Promise<HolographByNetworksResponse>

Get the HToken address per network.

Parameters​

• chainIds?: number[]

The list of network chainIds to get the results from, if nothing is provided the default are the networks defined in the config.

Returns​

Promise<HolographByNetworksResponse>

the hToken contract address per network.

Source​

packages/sdk/src/contracts/registry.contract.ts:242

getHolograph()​

readonly getHolograph(chainId): Promise<string | string[]>

Get the Holograph Protocol contract. This contract stores a reference to all the primary modules and variables of the protocol.

Parameters​

• chainId: number

The chain id of the network to get the result from.

Returns​

Promise<string | string[]>

the holograph contract address.

Source​

packages/sdk/src/contracts/registry.contract.ts:193

getHolographByNetworks()​

readonly getHolographByNetworks(chainIds?): Promise<HolographByNetworksResponse>

Get the Holograph Protocol contract. This contract stores a reference to all the primary modules and variables of the protocol.

Parameters​

• chainIds?: number[]

The list of network chainIds to get the results from, if nothing is provided the default are the networks defined in the config.

Returns​

Promise<HolographByNetworksResponse>

the holograph contract address per network.

Source​

packages/sdk/src/contracts/registry.contract.ts:204

getHolographableContracts()​

readonly getHolographableContracts(chainId, index, length): Promise<string | string[]>

Get set length list, starting from index, for all holographable contracts

Parameters​

• chainId: number

The chainId of the network to get the result from

• index: bigint

The index to start enumeration from

• length: bigint

The length of returned results

Returns​

Promise<string | string[]>

contracts address[] Returns a set length array of holographable contracts deployed in the chainId

Source​

packages/sdk/src/contracts/registry.contract.ts:325

getHolographableContractsByNetworks()​

readonly getHolographableContractsByNetworks(index, length, chainIds?): Promise<HolographByNetworksResponse>

Get set length list, starting from index, for all holographable contracts

Parameters​

• index: bigint

The index to start enumeration from

• length: bigint

The length of returned results

• chainIds?: number[]

The list of network chainIds to get the results from, if nothing is provided the default is the networks defined in the config

Returns​

Promise<HolographByNetworksResponse>

contracts address[] Returns a set length array of holographable contracts deployed per chainId

Source​

packages/sdk/src/contracts/registry.contract.ts:337

getHolographableContractsLength()​

readonly getHolographableContractsLength(chainId): Promise<string | string[]>

Get total number of deployed holographable contracts.

Parameters​

• chainId: number

The chain id of the network to get the result from.

Returns​

Promise<string | string[]>

the number of deployed holographable contracts.

Source​

packages/sdk/src/contracts/registry.contract.ts:414

getHolographableContractsLengthByNetworks()​

readonly getHolographableContractsLengthByNetworks(chainIds?): Promise<HolographByNetworksResponse>

Get total number of deployed holographable contracts per network.

Parameters​

• chainIds?: number[]

The list of network chainIds to get the results from, if nothing is provided the default are the networks defined in the config.

Returns​

Promise<HolographByNetworksResponse>

the number of deployed holographable contracts per network.

Source​

packages/sdk/src/contracts/registry.contract.ts:424

getHolographedHashAddress()​

readonly getHolographedHashAddress(chainId, hash): Promise<string | string[]>

Returns the address for a holographed hash.

Parameters​

• chainId: number

The chain id of the network to get the result from.

• hash: 0x${string}

The hash obtained by hashing all the necessary configuration parameters and converting them into a salt variable.

Returns​

Promise<string | string[]>

a contract address for the provided hash.

Source​

packages/sdk/src/contracts/registry.contract.ts:360

getHolographedHashAddressContractsByNetworks()​

readonly getHolographedHashAddressContractsByNetworks(hash, chainIds?): Promise<HolographByNetworksResponse>

Returns the address for a holographed hash per network.

Parameters​

• hash: 0x${string}

The hash obtained by hashing all the necessary configuration parameters and converting them into a salt variable.

• chainIds?: number[]

The list of network chainIds to get the results from, if nothing is provided the default are the networks defined in the config.

Returns​

Promise<HolographByNetworksResponse>

the contract address for the provided hash per network.

Source​

packages/sdk/src/contracts/registry.contract.ts:371

getReservedContractTypeAddress()​

readonly getReservedContractTypeAddress(chainId, contractType): Promise<string | string[]>

Returns the reserved contract address for a contract type.

Parameters​

• chainId: number

The chain id of the network to get the result from.

• contractType: 0x${string}

The bytes32 for the contract type.

Returns​

Promise<string | string[]>

the reserved contract address.

Source​

packages/sdk/src/contracts/registry.contract.ts:482

getReservedContractTypeAddressByNetworks()​

readonly getReservedContractTypeAddressByNetworks(contractType, chainIds?): Promise<HolographByNetworksResponse>

Returns the reserved contract address for a contract type per network.

Parameters​

• contractType: 0x${string}

The bytes32 for the contract type.

• chainIds?: number[]

The list of network chainIds to get the results from, if nothing is provided the default are the networks defined in the config.

Returns​

Promise<HolographByNetworksResponse>

the reserved contract address per network.

Source​

packages/sdk/src/contracts/registry.contract.ts:497

getUtilityToken()​

readonly getUtilityToken(chainId): Promise<string | string[]>

Get the Holograph Utility Token address. This is the official utility token of the Holograph Protocol

Parameters​

• chainId: number

The chain id of the network to get the result from.

Returns​

Promise<string | string[]>

the Holograph Utility Token contract address.

Source​

packages/sdk/src/contracts/registry.contract.ts:281

getUtilityTokenByNetworks()​

readonly getUtilityTokenByNetworks(chainIds?): Promise<HolographByNetworksResponse>

Get the Holograph Utility Token address per network. This is the official utility token of the Holograph Protocol.

Parameters​

• chainIds?: number[]

The list of network chainIds to get the results from, if nothing is provided the default are the networks defined in the config.

Returns​

Promise<HolographByNetworksResponse>

the Holograph Utility Token contract address per network.

Source​

packages/sdk/src/contracts/registry.contract.ts:292

isHolographedContract()​

readonly isHolographedContract(chainId, contractAddress): Promise<string | string[]>

Checks if the contract it's aligned with the Holograph standard.

Parameters​

• chainId: number

The chain id of the network to get the result from.

• contractAddress: 0x${string}

The contract address.

Returns​

Promise<string | string[]>

true if it's holographed, and false otherwise.

Source​

packages/sdk/src/contracts/registry.contract.ts:66

isHolographedContractByNetworks()​

readonly isHolographedContractByNetworks(contractAddress, chainIds?): Promise<HolographByNetworksResponse>

Checks if the contract it's aligned with the Holograph standard by network.

Parameters​

• contractAddress: 0x${string}

The contract address.

• chainIds?: number[]

The list of network chainIds to get the results from, if nothing is provided the default are the networks defined in the config.

Returns​

Promise<HolographByNetworksResponse>

true if it's holographed, and false otherwise per network.

Source​

packages/sdk/src/contracts/registry.contract.ts:77

isHolographedHashDeployed()​

readonly isHolographedHashDeployed(chainId, hash): Promise<string | string[]>

Checks if the hash is deployed.

Parameters​

• chainId: number

The chain id of the network to get the result from.

• hash: 0x${string}

The hash obtained by hashing all the necessary configuration parameters and converting them into a salt variable.

Returns​

Promise<string | string[]>

true if it's deployed, and false otherwise.

Source​

packages/sdk/src/contracts/registry.contract.ts:103

isHolographedHashDeployedByNetworks()​

readonly isHolographedHashDeployedByNetworks(hash, chainIds?): Promise<HolographByNetworksResponse>

Checks if the hash is deployed per network.

Parameters​

• hash: 0x${string}

The hash obtained by hashing all the necessary configuration parameters and converting them into a salt variable.

• chainIds?: number[]

The list of network chainIds to get the results from, if nothing is provided the default are the networks defined in the config.

Returns​

Promise<HolographByNetworksResponse>

true if it's deployed, and false otherwise per network.

Source​

packages/sdk/src/contracts/registry.contract.ts:115

referenceContractTypeAddress()​

readonly referenceContractTypeAddress(chainId, contractAddress): Promise<string | string[]>

Allows to reference a deployed smart contract, and use it's code as reference inside of Holographers.

Parameters​

• chainId: number

The chain id of the network to get the result from.

• contractAddress: 0x${string}

the contract address.

Returns​

Promise<string | string[]>

the bytes32 contract type.

Source​

packages/sdk/src/contracts/registry.contract.ts:445

referenceContractTypeAddressByNetworks()​

readonly referenceContractTypeAddressByNetworks(contractAddress, chainIds?): Promise<HolographByNetworksResponse>

Allows to reference a deployed smart contract, and use it's code as reference inside of Holographers.

Parameters​

• contractAddress: 0x${string}

the contract address.

• chainIds?: number[]

The list of network chainIds to get the results from, if nothing is provided the default are the networks defined in the config.

Returns​

Promise<HolographByNetworksResponse>

the bytes32 contract type per network.

Source​

packages/sdk/src/contracts/registry.contract.ts:460

setContractTypeAddress()​

Only Admin

setContractTypeAddress(chainId, contractType, contractAddress, wallet?): Promise<string | string[]>

Sets the contract address for a contract type.

Parameters​

• chainId: number

The chainId of the network to send the transaction to.

• contractType: 0x${string}

The contract type bytes32.

• contractAddress: 0x${string}

The contract address for the provided contract type.

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction

Source​

packages/sdk/src/contracts/registry.contract.ts:172

setHToken()​

Only Admin

setHToken(chainId, hTokenChainId, hToken, wallet?): Promise<string | string[]>

Sets the hToken address for a specific chain id.

Parameters​

• chainId: number

The chainId of the network to send the transaction to.

• hTokenChainId: number

the hToken address chain id.

• hToken: 0x${string}

The hToken contract address.

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/registry.contract.ts:265

setHolograph()​

Only Admin

setHolograph(chainId, address, wallet?): Promise<string | string[]>

Sets the Holograph module contract address.

Parameters​

• chainId: number

The chainId of the network to send the transaction to.

• address: 0x${string}

The Holograph module contract address.

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/registry.contract.ts:222

setHolographedHashAddress()​

Only Admin

setHolographedHashAddress(chainId, hash, contractAddress, wallet?): Promise<string | string[]>

Allows Holograph Factory to register a deployed contract, referenced with deployment hash

Parameters​

• chainId: number

The chainId of the network to send the transaction to.

• hash: 0x${string}

The hash obtained by hashing all the necessary configuration parameters and converting them into a salt variable.

• contractAddress: 0x${string}

the contract address for the provided hash.

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/registry.contract.ts:394

setReservedContractTypeAddress()​

Only Admin

setReservedContractTypeAddress(chainId, hash, reserved, wallet?): Promise<string | string[]>

Allows admin to update or toggle reserved types.

Parameters​

• chainId: number

The chainId of the network to send the transaction to.

• hash: 0x${string}

• reserved: boolean

A boolean.

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/registry.contract.ts:520

setReservedContractTypeAddresses()​

Only Admin

setReservedContractTypeAddresses(chainId, hashes, reserved, wallet?): Promise<string | string[]>

Allows admin to update or toggle multiple reserved types.

Parameters​

• chainId: number

The chainId of the network to send the transaction to.

• hashes: 0x${string}[]

A bytes32 array for the contract typeS.

• reserved: boolean[]

A boolean array.

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/registry.contract.ts:542

setUtilityToken()​

Only Admin

setUtilityToken(chainId, utilityToken, wallet?): Promise<string | string[]>

Update the Holograph Utility Token address

Parameters​

• chainId: number

The chainId of the network to send the transaction to.

• utilityToken: 0x${string}

The address of the Holograph Utility Token smart contract to use

• wallet?

• wallet.account?: string | HolographWallet

Returns​

Promise<string | string[]>

A transaction.

Source​

packages/sdk/src/contracts/registry.contract.ts:313

validateWallet()​

protected validateWallet(wallet?): HolographWallet

Parameters​

• wallet?: HolographWallet | object

Returns​

HolographWallet

Inherited from​

HolographBaseContract.validateWallet

Source​

packages/sdk/src/contracts/holograph-base.contract.ts:54